//
// Encog(tm) Core v3.3 - .Net Version
// http://www.heatonresearch.com/encog/
//
// Copyright 2008-2014 Heaton Research, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//  http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//   
// For more information on Heaton Research copyrights, licenses 
// and trademarks visit:
// http://www.heatonresearch.com/copyright
//
using System;
namespace Encog.Util.Identity
{
    /// <summary>
    /// Generate unique id's.  ID's start at 1.
    /// </summary>
    [Serializable]
    public class BasicGenerateID : IGenerateID
    {
        /// <summary>
        /// Construct an ID generator.
        /// </summary>
        public BasicGenerateID()
        {
            CurrentID = 1;
        }

        #region IGenerateID Members

        /// <summary>
        /// The current id to generate.  This is the next id returned.
        /// </summary>
        public long CurrentID { get; set; }

        /// <summary>
        /// Generate a unique id.
        /// </summary>
        /// <returns>The unique id.</returns>
        public long Generate()
        {
            lock (this)
            {
                return CurrentID++;
            }
        }

        #endregion
    }
}
